home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / wildcat / netbull.zip / NETBULL.DOC < prev    next >
Text File  |  1992-11-26  |  17KB  |  359 lines
  1.                                    NETBULL
  2.                                 + + + + + + +  
  3.  
  4.                         Version 2.23      Compiled 11/26/92
  5.                                       by
  6.                                Michael A. Conley
  7.  
  8.                Another public domain Wildcat! 3.x SysOp utility 
  9.                        from the Charlatan's Cabin BBS.
  10.  
  11.                       (requires BRUN40.EXE in the path)
  12.  
  13.                            (requires Wildcat! 3.x)
  14.  
  15. WHAT IT DOES:
  16. =============
  17. NETBULL reads logs from TNET, POSTLINK, PCRELAY, and WILDMAIL, as well as 
  18. CONFDESC.DAT from Wildcat! 3.x, and builds a bulletin detailing the 4 most 
  19. recent network mail transfers, as well as a brief display screen listing 
  20. the date of the most recent transfer for each network, and the total 
  21. messages in-and-out on that date.  It will also generate an opening screen 
  22. for Tomcat! version 3.x and above.
  23.  
  24. NEW IN THIS VERSION:
  25. ==================== 
  26. Version 2.20 adds support for the new POSTLINK echo mail processing software
  27. by Kip Compton.  POSTLINK is expected to eventually replace PCRelay, but
  28. NETBULL will continue to support BOTH for the time being until PCRelay is
  29. no longer commonly used.  Another new feature is the added switch "/@PAUSE"
  30. which may be used with HELLO or BULLETIN files.  This will cause NETBULL to
  31. generate a Wildcat! compatible "@PAUSE@" line at the end of a display file,
  32. to prevent it from scrolling offscreen if additional text files follow it.
  33. There is now an added configuration option "EXCLUDE=" which may be used to
  34. skip any conferences you don't want included.  An intelligent parser will
  35. let you specify them individually (1,2,5) or by ranges (1-15), or any 
  36. combination of the two formats.
  37.  
  38. UPDATING FROM PRIOR VERSIONS:
  39. =============================
  40. If you're already running version 2.x of NETBULL, your existing configuration
  41. file will continue to work.  You may with to add a new line.  See "HIGHLIGHT="
  42. in the sample file, which allows you to highlight specific conferences or
  43. ranges of conferences with a different color.  This might be used to point out
  44. new conferences or to highlight those of special interest.
  45.  
  46. Version 2 is a major rewrite of NETBULL and it requires a new configuration
  47. file.  NETBULL now supports multiple TNET, PCRELAY, and WILDMAIL files, and
  48. will report independent transfer counts and last successful transfer times
  49. on a net-by-net basis.   Note that you may direct ALL of your TNET transfers
  50. to one log if desired, because the program matches the HUB NAME in the log.
  51. With PCRELAY and WILDMAIL, separate logs should be used for each HUB in
  52. order to distinguish the net name and transfer times individually.
  53.  
  54. WHAT IT DOES:
  55. =============
  56. NETBULL reads logs from TNET, POSTLINK, PCRELAY, and WILDMAIL, as well as 
  57. CONFDESC.DAT from Wildcat! 3.x, and builds a bulletin detailing the 4 most 
  58. recent network mail transfers, as well as a brief display screen listing 
  59. the date of the most recent transfer for each network, and the total 
  60. messages in-and-out on that date.  It will also generate an opening 
  61. screen for Tomcat! version 3.x and above.
  62.  
  63. TNET SETUP:
  64. ===========
  65. In order to use TNET with NETBULL, you must include the following lines in
  66. each of your '.CFG' files used by TNET:
  67.  
  68.         LOGFILE=TNET.LOG
  69.         VERBOSE=NO
  70.  
  71. You may choose another name for your logfile, but be sure it matches the
  72. LOGFILE= entry in the NETBULL configuration file (see below.)  It is
  73. essential that verbose logging be turned off (that's the default ... the
  74. line above isn't really needed, but it will remind you NOT to set VERBOSE
  75. to 'YES' ... NETBULL doesn't read the logs in verbose format.  You will
  76. not need a REFERENCE= file with TNET, as it reports WC30 conference
  77. numbers in its operations, and can be traced directly to CONFDESC.DAT.
  78.  
  79. WILDMAIL SETUP:
  80. ==============
  81. If you're using WILDMAIL, you must specify the location of your AREAS.BBS
  82. file so that NETBULL can cross-reference network conference names to local
  83. conference numbers.  See the REFERENCE= line in the configuration sample
  84. below.  If you have multiple WILDMAIL HUBS, create a separate log for each 
  85. one in case there are any overlapping conference names in the network 
  86. software.  We also suggest that you create a separate AREAS.BBS for each
  87. WILDMAIL HUB in case there are overlapping conference names on the various
  88. networks.
  89.  
  90. POSTLINK SETUP:  
  91. =============== 
  92. If you're running POSTLINK, you won't need to create any special files as
  93. you previously did with PCRelay.  Simply set the NETBULL configuration
  94. file's "REFERENCE=" line to point at CONFLST.NET and it will parse the 
  95. cross-reference information from that file, which is maintained by your
  96. TMANAGE (or MANAGE) program, using the UTIs.
  97.  
  98. PCRELAY SETUP:
  99. ==============
  100. If you're using PCRelay, you must use your PCRelay software's CONFIG 
  101. program to prepare a cross-reference file for NETBULL.
  102.  
  103. You'll need to first log into your PCRELAY directory and run the CONFIG
  104. program.  Select Conference maintenance and PRINT a listing (TO DISK) 
  105. called RELAY.REF.  This will let the program cross-reference the names
  106. of the conferences used by PCRELAY with the matching conference numbers on
  107. your system.  While you're in CONFIG, check the output path and filename 
  108. of the relay log ... you'll need this in a moment.   If you have multiple
  109. PCRELAY HUBS, create a separate log for each one.  We suggest that you
  110. also create a separate RELAY.REF for each one in case there are any 
  111. overlapping conference names in the network software.
  112.  
  113. SETTING UP:
  114. ===========
  115. You may specify up to 19 output files in NETBULL.CFG, a simple ASCII text
  116. file which contains filenames and optional flags for the program.  Here's a
  117. sample NETBULL.CFG, with a brief explanation.  A copy of this configuration
  118. file is enclosed in the ZIP file for your convenience:
  119.  
  120. BBSNAME=The Charlatan's Cabin BBS
  121. BULLETIN=C:\WC30\BULL\BULL43.BBS /@CODE /@CLS
  122. HELLO=C:\WC30\DISP\HELLO8.BBS /@CODE /@PAUSE
  123. TOMCAT=C:\WC30\DISP\TOMCAT.BBS
  124. BULLETIN=C:\WC30\NETMAIL.LST
  125. HIGHLIGHT=30-33, 95-101
  126. EXCLUDE=0-10,22,35-70
  127.  
  128. LOGFILE=C:\WC30\TNET.LOG
  129. LOGTYPE=TNET
  130. REFERENCE=NONE
  131. HUBID=MOGUR
  132. NETNAME=NorthAmeriNet
  133.  
  134. LOGFILE=C:\WC30\TNET.LOG
  135. LOGTYPE=TNET
  136. REFERENCE=NONE
  137. HUBID=PANASIA
  138. NETNAME=The Intelec(tm) Network
  139.  
  140. LOGFILE=C:\WC30\TNET.LOG
  141. LOGTYPE=TNET
  142. REFERENCE=NONE
  143. HUBID=HOTLINE
  144. NETNAME=The SmartNet Network
  145.  
  146. LOGFILE=C:\PCRELAY\RELAY.LOG
  147. LOGTYPE=PCRELAY
  148. REFERENCE=C:\PCRELAY\RELAY.REF
  149. HUBID=NONE
  150. NETNAME=RelayNet International Mail Exchange
  151.  
  152. LOGFILE=C:\WC30\WM.LOG
  153. LOGTYPE=WILDMAIL
  154. REFERENCE=C:\WC30\AREAS.BBS
  155. HUBID=1:268/302
  156. NETNAME=Fido Mail
  157.  
  158. LOGFILE=C:\WC30\WM.LOG
  159. LOGTYPE=WILDMAIL
  160. REFERENCE=C:\WC30\AREAS.BBS
  161. HUBID=86:8012/3
  162. NETNAME=ToadNet Mail
  163.  
  164. LOGFILE=C:\WC30\WM.LOG
  165. LOGTYPE=WILDMAIL
  166. REFERENCE=C:\WC30\AREAS.BBS
  167. HUBID=1:282/85 
  168. NETNAME=Prowl Mail
  169.  
  170. LOGFILE=C:\WC30\WM.LOG
  171. LOGTYPE=WILDMAIL
  172. REFERENCE=C:\WC30\AREAS.BBS
  173. HUBID=230:230/1
  174. NETNAME=CRNet Mail
  175.  
  176. LOGFILE=D:\POSTLINK\POSTLINK.LOG
  177. LOGTYPE=POSTLINK
  178. REFERENCE=D:\POSTLINK\CONFLST.NET
  179. HUBID=NONE
  180. NETNAME=RelayNet International Mail Exchange
  181.  
  182.  
  183. ===============================================================================
  184. |Explanation of the configuration options:
  185. |
  186. |The BBSNAME= is the name of your BBS as you'd like it to appear in the display 
  187. |files.
  188. |
  189. |You may specify up to 19 output files in any combination of the three
  190. |available types:  BULLETIN=, HELLO=, and TOMCAT= .
  191. |
  192. |Each file can take one of three forms:  If the line begins with HELLO=, 
  193. |then the output will be a brief summary of transfer activity on the day 
  194. |the last successful transfers were run.  If the line begins with BULLETIN=, 
  195. |then it will be a full listing of activity over the past 4 days, ending
  196. |with the date of the last successful transfer.  Finally, if the line begins 
  197. |with TOMCAT=, it will generate a Tomcat! opening screen with a brief summary 
  198. |of transfer activity. If you're using Tomcat! 3.01 or later, this screen will 
  199. |be displayed each time Tomcat! is started.  It includes the official Tomcat! 
  200. |kitty character, used with Greg Hewgill's permission.
  201. |
  202. |Three SWITCHES may be added to each file line ... Inserting the /@CODE switch 
  203. |will produce Wildcat! 3.0 compatible color codes, which will automatically 
  204. |be filtered out by Wildcat! 3.0 if the caller is not color-capable.  Thus, 
  205. |only ONE output file is needed for your COLOR and MONO callers.
  206. |             
  207. |The /ANSI switch will insert standard ANSI color codes, and these display 
  208. |files should ONLY be used for color applications, such as earlier versions of 
  209. |Wildcat! BBS software, where .SCR files are COLOR and .BBS files are ASCII. In 
  210. |that case, you'd want to produce both a .BBS and a .SCR version of each file.
  211. |           
  212. |DON'T use /ANSI and /@CODE on the same line.  You'll confuse me.
  213. |               
  214. |You may also add a /@CLS switch, which will add the appropriate clear screen 
  215. |code at the beginning of the file.  If no color switch is indicated, the /CLS 
  216. |will generate a formfeed (ASCII 12), or if there is a color flag, then the 
  217. |clear screen code will be appropriate to the selected format.
  218. |
  219. |You may also place a /@PAUSE switch on the line, which will insert the Wildcat!
  220. |@PAUSE@ code at the end of the file.  This option will be ignored if a Tomcat!
  221. |file is specified, but will be added to the end of a HELLO or BULLETIN file if
  222. |requested.
  223. |
  224. |HIGHLIGHT= is an optional list of conference names you would like highlighted
  225. |in the color display files.  No highlighting will be performed in the ASCII
  226. |(non-colorized) files.  You may enter individual areas separated by commas,
  227. |or ranges of areas separated by a hyphen, for example:
  228. |HIGHLIGHT=0-3,35,38,101-110,124
  229. |
  230. |
  231. |EXCLUDE= is an optional list of conference names you would like EXCLUDEed
  232. |in the display files.  You may enter individual areas separated by commas,
  233. |or ranges of areas separated by a hyphen, for example:
  234. |EXCLUDE=0-10,22,35-70
  235. |
  236. |
  237. |LOG file specifications:
  238. |========================
  239. |
  240. |  LOGFILE=   This is the complete drive and pathname to the LOG you
  241. |             wish to read.  Any DOS filename is acceptable, but be
  242. |             sure to include the complete drive & path even if it's
  243. |             in the directory where NETBULL is started.
  244. |
  245. |  LOGTYPE=   This tells NETBULL how to read the log.  At present, four
  246. |             log types are known to NETBULL:  TNET, POSTLINK, PCRELAY 
  247. |             and WILDMAIL. We may add others if there's enough interest.
  248. |
  249. |  REFERENCE= If you specify a log type of POSTLINK, PCRELAY or WILDMAIL,
  250. |             NETBULL will need to read a REFERENCE FILE to translate the 
  251. |             log file conference names and numbers into the conference 
  252. |             names and numbers on your BBS.  Check the NETBULL documen-
  253. |             tation and then enter the complete drive, path, and filename
  254. |             for the reference file here.  If the LOGTYPE is TNET, you 
  255. |             should specify "REFERENCE=NONE"      
  256. |
  257. |  HUBID=     This is used by TNET and by WILDMAIL, but NOT by POSTLINK 
  258. |             nor PCRELAY. Since TNET lists the name of the HUB in the log,
  259. |             you may choose to keep only ONE log file for your various 
  260. |             TNET imports and exports.  If the LOGTYPE is TNET, then you
  261. |             must enter the HUBID here.  It must match exactly the
  262. |             name of the HUB as shown in your TNET log file.
  263. |
  264. |             In the case of WILDMAIL, insert the FIDO ID number here,
  265. |             for example HUBID=86:8012/3. In this way, you can separate
  266. |             each HUB into a separate listing while using only one log.
  267. |
  268. |  NETNAME=   This is the name of the network as you want it to be shown
  269. |             in the display files.  An entry may be up to 40 characters
  270. |             in length.  Any excess will be truncated in order to fit
  271. |             the format of the display file.
  272. |
  273. |       A total of 19 LOG FILE groups are supported by NETBULL.
  274.  
  275.  
  276. Running the program:
  277. ====================
  278. We suggest running the program at the end of your mail processing batch file
  279.  ... that way it will always be current with any transfer activity.  Note that 
  280. if you perform more than 1 transfer in a day, the numbers will be added up for 
  281. each day's totals.   
  282.  
  283. OPTIONAL feature:  You may change the default configuration file name for
  284. the current run by specifying a configuration file on the command line.
  285.  
  286. ANOTHER SUGGESTION:  The current version of my program LOGTRIM will allow
  287. you to trim any ASCII log (ACTIVITY.LOG, RELAY.LOG, TNET.LOG, etc) to keep
  288. the last NN days.  It calculates backwards from the current day, so it can
  289. be called from a batch file to keep a log at a fixed number of days.
  290.  
  291. LOGTRIM RELAY 7   <-- would keep the last 7 days in RELAY.LOG.
  292.  
  293. LOGTRIM is readily available ... feel free to call my board (see below)
  294. if you have any trouble finding it.
  295.  
  296.  
  297. PROBLEMS, SUGGESTIONS:
  298. ======================
  299.  
  300. This program is public domain.  I don't seek or accept any donations for 
  301. this  or any of my other Wildcat! utility programs, including TODAYBBS, 
  302. FLOP, MSTAT, USTAT, and others.
  303.  
  304. I welcome suggestions, and will try to help (no guarantees) if there are
  305. problems.
  306.  
  307. You may contact me at The Charlatan's Cabin BBS  (213) 654-7337.  Mention
  308. your Wildcat! registration number in the comment and you'll be upgraded to
  309. visiting sysop level without the usually required registration by mail.
  310.  
  311. You may also leave a message via CompuServe EMail. My CompuServe account 
  312. number is 70250,220.  I also regularly check the Mustang Software head-
  313. quarters BBS, especially the "3rd Party Utilities Help" conference.
  314.  
  315. Please, NO VOICE CALLS.  This isn't meant to be unfriendly, but with the 
  316. price of public domain software these days ... I just can't afford to be 
  317. "on call."  I WILL respond to your questions via my BBS or CompuServe,
  318. or via the Mustang Software registered SysOp BBS.
  319.  
  320. ============================================================================
  321.  
  322. HISTORY:
  323. ========
  324.  
  325. 1.00        Compiled  9/13/91  First release / replaced BETA TNETBULL with
  326.                                this program which supports both TNET and
  327.                                PCRelay.
  328.  
  329. 2.00        Compiled 03/03/92  Significant update: Now supports multiple log
  330.                                files for TNET, PCRELAY, and WILDMAIL.  New
  331.                                configuration file structure required.  Reduced
  332.                                maximum number of output files to 19 to save 
  333.                                memory for some other features.
  334. 2.01        Compiled 03/07/92  Minor bug fixes: shortened TOMCAT.BBS display by
  335.                                one line because Tomcat! menu is now longer.
  336.                                Also made adjustments to config file parsing to
  337.                                allow for very short HUBID's.
  338. 2.02        Compiled 03/21/92  Minor enhancement: now accepts alternate config
  339.                                file name from the command line.  If none found,
  340.                                defaults to NETBULL.CFG
  341. 2.03        Compiled 03/21/92  Bug fix: Wasn't removing color codes from the
  342.                                header if a color file was written before an
  343.                                ASCII file.
  344. 2.10        Compiled 03/28/92  Add HIGHLIGHT option to put a highlight color
  345.                                on desired conferences, made some improvements
  346.                                in configuration parsing.
  347. 2.11        Compiled 06/25/92  Update for Wildmail! version 2.03 to handle the
  348.                                new logging structure.
  349. 2.12        Compiled 07/12/92  Minor changes in parsing of Wildmail! 2.03 files
  350.                                to better handle format variations (AREAS.BBS).
  351. 2.20        Compiled 09/08/92  Added support for POSTLINK echomail software.
  352. 2.21        (unreleased test)
  353. 2.22        Compiled 10/10/92  Fixed bug which could produce a Traceback 62
  354.                                error due to a minor format change in the 
  355.                                Postlink log.
  356. 2.23        Compiled 11/26/92  Added trapping for numbered, but un-named
  357.                                conferences in Wildmail! AREAS.BBS file.
  358.  
  359.